[yaml] add FileIO docs #33185
[yaml] add FileIO docs #33185
Conversation
|
R: @robertwb |
|
R: @damccorm |
|
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment |
|
Oh, please fix the precommits |
Polber
force-pushed
the
jkinard/file-docs
branch
from
7ae8638 to
5c3904d
Compare
|
Looks like precommits are still failing |
Polber
force-pushed
the
jkinard/file-docs
branch
3 times, most recently
from
629390a to
50b4cef
Compare
Signed-off-by: Jeffrey Kinard <[email protected]>
Signed-off-by: Jeffrey Kinard <[email protected]>
Signed-off-by: Jeffrey Kinard <[email protected]>
Polber
force-pushed
the
jkinard/file-docs
branch
from
50b4cef to
2eac016
Compare
Signed-off-by: Jeffrey Kinard <[email protected]>
Polber
force-pushed
the
jkinard/file-docs
branch
from
2eac016 to
c90624e
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #33185 +/- ##
=========================================
Coverage 57.41% 57.42%
Complexity 1474 1474
=========================================
Files 970 970
Lines 154498 154526 +28
Branches 1076 1076
=========================================
+ Hits 88708 88732 +24
- Misses 63586 63590 +4
Partials 2204 2204
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| @@ -86,10 +86,16 @@ def _fake_value(name, beam_type): | |||
| raise ValueError(f"Unrecognized type_info: {type_info!r}") | |||
|
|
|||
|
|
|||
| EXCLUDE_ARGS = ['args', 'kwargs'] | |||
There was a problem hiding this comment.
We can't always filter these out, e.g. https://beam.apache.org/releases/yamldoc/current/#pytransform
There was a problem hiding this comment.
Ah.. right.. let me rethink
| <https://pandas.pydata.org/docs/reference/api/pandas.read_json.html> | ||
|
|
||
| Args: | ||
| path (str): The file path to read from as a local file path or a |
There was a problem hiding this comment.
Note that we support more than local files and gcs; the set of filesystems is not closed.
There was a problem hiding this comment.
Right, I also found that limiting, but I copied that description from another docstring, e.g.
beam/sdks/python/apache_beam/io/textio.py
Lines 757 to 759 in 142e392
Signed-off-by: Jeffrey Kinard <[email protected]>
Add docs for all the FileIO YAML Providers. This includes separating out the providers into standalone function calls rather than using a remaning provider referencing th source transform. This allows for YAML-specific docs and possibe future YAML-specific pre/post processing
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.